Removed redundant Str.htmlDecode #20443

alitoshmatov · 2023-06-08T07:25:21Z

Regression of #19237 was spotted in #19789 .
To fix this we are removing Str.htmlDecode from places where it was used on plain texts.

Details

Fixed Issues

$ #19789
PROPOSAL: N/A

Tests

Switch to offline mode
Go to any chat
Write  and send
Make sure in LHN it shows as it is

Verify that no errors appear in the JS console

Offline tests

Same as tests

QA Steps

Same as tests

Verify that no errors appear in the JS console

PR Author Checklist

I linked the correct issue in the ### Fixed Issues section above
I wrote clear testing steps that cover the changes made in this PR
- I added steps for local testing in the Tests section
- I added steps for the expected offline behavior in the Offline steps section
- I added steps for Staging and/or Production testing in the QA steps section
- I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
- I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
I included screenshots or videos for tests on all platforms
I ran the tests on all platforms & verified they passed on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
I followed proper code patterns (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
  - If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I followed the guidelines as stated in the Review Guidelines
I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
I verified that if a function's arguments changed that all usages have also been updated correctly
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

19789-web.mov

Mobile Web - Chrome

https://github.com/Expensify/App/assets/59907218/a2248e55-72ea-4674-a3b4-54467f78cc52

Mobile Web - Safari

19789-safari.mp4

Desktop

19789-desktop.mov

iOS

19789-ios.mp4

Android

19789.mp4

alitoshmatov · 2023-06-08T07:27:31Z

@s77rt Only instance of Str.htmlDecode is left here

App/src/pages/home/report/ReportActionItemMessageEdit.js

Line 100 in b8d4576

draftMessage = Str.htmlDecode(this.props.draftMessage);

s77rt · 2023-06-08T11:00:04Z

Let's also update expensify-common (hold for Expensify/expensify-common#543)

s77rt · 2023-06-08T11:00:41Z

src/libs/actions/IOU.js

-        Str.htmlDecode(moneyRequestAction.originalMessage.comment),
+        moneyRequestAction.originalMessage.comment,


Are we sure this is a plain text?

Where ever I look, originalMessage.comment is not present. There is only html field inside originalMessage.

What was the console log for originalMessage.comment? Can you check where we set it, and do we set html or text

comment field simply didn't exist here when I logged. I couldn't find place where comment is set

I see, I think IOU messages are always in plain text. Looking at this I found another bug in getIOUReportActionMessage. The html version here

App/src/libs/ReportUtils.js

Line 1298 in 81b631b

html: iouMessage,

should be the encoded version of text.

html: _.escape(iouMessage), text: iouMessage,

@alitoshmatov Can you apply this change as well

s77rt · 2023-06-08T11:03:54Z

@alitoshmatov

Only instance of Str.htmlDecode is left here

The input in that case is html right?

alitoshmatov · 2023-06-08T13:40:56Z

@s77rt

The input in that case is html right?

Yes, I tested by logging it in console and it is escaped special charecters and comment above this code also supports it

App/src/pages/home/report/ReportActionItemMessageEdit.js

Lines 99 to 100 in b8d4576

    
           // We need to decode saved draft message because it's escaped before saving. 
        
           draftMessage = Str.htmlDecode(this.props.draftMessage);

s77rt · 2023-06-08T15:30:03Z

@alitoshmatov

Yes, I tested by logging it in console and it is escaped special charecters and comment above this code also supports it

The comment may be outdated, a lot has changed regarding decoding. Can you please post the logs for this one (and how can this be reproduced)

s77rt · 2023-06-08T17:32:34Z

Expensify/expensify-common#543 has been merged. Please update expensify-common version.

alitoshmatov · 2023-06-08T18:24:05Z

To reproduce this, you can start editing one of the messages and reload the page to get this piece of code working

s77rt · 2023-06-08T19:08:04Z

Got it thanks. Let me know when this is ready for review & tests

…move-htmlDecode

melvin-bot · 2023-06-12T18:56:20Z

@stitesExpensify @s77rt One of you needs to copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

alitoshmatov · 2023-06-12T19:07:35Z

@s77rt Ready for review

s77rt · 2023-06-13T17:37:54Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

web.mp4

Mobile Web - Chrome

mweb-chrome.mp4

Mobile Web - Safari

mweb-safari.mp4

Desktop

desktop.mp4

iOS

ios.mp4

Android

android.mp4

s77rt

LGTM! 🚀

cc @stitesExpensify

OSBotify · 2023-06-14T15:00:00Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-06-14T21:25:38Z

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 1.3.28-0 🚀

platform	result
🤖 android 🤖	failure ❌
🖥 desktop 🖥	failure ❌
🍎 iOS 🍎	failure ❌
🕸 web 🕸	failure ❌

OSBotify · 2023-06-16T18:40:46Z

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.3.28-5 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

Removed redundant Str.htmlDecode

211a514

alitoshmatov mentioned this pull request Jun 8, 2023

[HOLD for payment 2023-06-23] [$1000] valid html code displays 'this is beginning...' and invalid html code displays weird symbol in LHN for few seconds #19789

Closed

6 tasks

s77rt reviewed Jun 8, 2023

View reviewed changes

Updated expensify-common

64b318a

s77rt mentioned this pull request Jun 9, 2023

[HOLD for payment 2023-06-01] [$1000] Web - Chat - In offline mode, on deleting any latest message, if last message has & sign in it, app displays it as & in LHN #17658

Closed

6 tasks

Merge branch 'main' of https://github.com/Expensify/App into 19789/re…

4ba5a3f

…move-htmlDecode

stitesExpensify self-requested a review June 12, 2023 18:18

alitoshmatov added 2 commits June 12, 2023 23:39

Updated expensify-common

0b7438d

Merge branch 'main' of https://github.com/Expensify/App into 19789/re…

2358942

…move-htmlDecode

alitoshmatov marked this pull request as ready for review June 12, 2023 18:56

alitoshmatov requested a review from a team as a code owner June 12, 2023 18:56

melvin-bot bot requested review from s77rt and removed request for a team June 12, 2023 18:56

Encoding text in getting iou report action message

194f2a2

s77rt approved these changes Jun 13, 2023

View reviewed changes

stitesExpensify approved these changes Jun 14, 2023

View reviewed changes

stitesExpensify merged commit b20f917 into Expensify:main Jun 14, 2023

OSBotify mentioned this pull request Jun 14, 2023

Deploy Checklist: New Expensify 2023-06-14 #20782

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Removed redundant Str.htmlDecode #20443

Removed redundant Str.htmlDecode #20443

alitoshmatov commented Jun 8, 2023 •

edited

Loading

alitoshmatov commented Jun 8, 2023

s77rt commented Jun 8, 2023

s77rt Jun 8, 2023

alitoshmatov Jun 8, 2023

s77rt Jun 8, 2023

alitoshmatov Jun 8, 2023

s77rt Jun 8, 2023

s77rt Jun 12, 2023

alitoshmatov Jun 13, 2023

s77rt commented Jun 8, 2023

alitoshmatov commented Jun 8, 2023

s77rt commented Jun 8, 2023

s77rt commented Jun 8, 2023

alitoshmatov commented Jun 8, 2023 •

edited

Loading

s77rt commented Jun 8, 2023

melvin-bot bot commented Jun 12, 2023

alitoshmatov commented Jun 12, 2023

s77rt commented Jun 13, 2023

s77rt left a comment

OSBotify commented Jun 14, 2023

OSBotify commented Jun 14, 2023

OSBotify commented Jun 16, 2023

		Str.htmlDecode(moneyRequestAction.originalMessage.comment),
		moneyRequestAction.originalMessage.comment,

Removed redundant Str.htmlDecode #20443

Removed redundant Str.htmlDecode #20443

Conversation

alitoshmatov commented Jun 8, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

alitoshmatov commented Jun 8, 2023

s77rt commented Jun 8, 2023

s77rt Jun 8, 2023

Choose a reason for hiding this comment

alitoshmatov Jun 8, 2023

Choose a reason for hiding this comment

s77rt Jun 8, 2023

Choose a reason for hiding this comment

alitoshmatov Jun 8, 2023

Choose a reason for hiding this comment

s77rt Jun 8, 2023

Choose a reason for hiding this comment

s77rt Jun 12, 2023

Choose a reason for hiding this comment

alitoshmatov Jun 13, 2023

Choose a reason for hiding this comment

s77rt commented Jun 8, 2023

alitoshmatov commented Jun 8, 2023

s77rt commented Jun 8, 2023

s77rt commented Jun 8, 2023

alitoshmatov commented Jun 8, 2023 • edited Loading

s77rt commented Jun 8, 2023

melvin-bot bot commented Jun 12, 2023

alitoshmatov commented Jun 12, 2023

s77rt commented Jun 13, 2023

Reviewer Checklist

Screenshots/Videos

s77rt left a comment

Choose a reason for hiding this comment

OSBotify commented Jun 14, 2023

OSBotify commented Jun 14, 2023

OSBotify commented Jun 16, 2023

alitoshmatov commented Jun 8, 2023 •

edited

Loading

alitoshmatov commented Jun 8, 2023 •

edited

Loading